<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2011 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except<a name="line.4"></a>
<span class="sourceLineNo">005</span> * in compliance with the License. You may obtain a copy of the License at<a name="line.5"></a>
<span class="sourceLineNo">006</span> *<a name="line.6"></a>
<span class="sourceLineNo">007</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * Unless required by applicable law or agreed to in writing, software distributed under the<a name="line.9"></a>
<span class="sourceLineNo">010</span> * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either<a name="line.10"></a>
<span class="sourceLineNo">011</span> * express or implied. See the License for the specific language governing permissions and<a name="line.11"></a>
<span class="sourceLineNo">012</span> * limitations under the License.<a name="line.12"></a>
<span class="sourceLineNo">013</span> */<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>package com.google.common.collect;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import static com.google.common.base.Preconditions.checkArgument;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import static com.google.common.base.Preconditions.checkNotNull;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import com.google.common.annotations.Beta;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import com.google.common.annotations.GwtIncompatible;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.Serializable;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Arrays;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Collection;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Collections;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Comparator;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Iterator;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * An immutable {@code SortedMultiset} that stores its elements in a sorted array. Some instances<a name="line.32"></a>
<span class="sourceLineNo">033</span> * are ordered by an explicit comparator, while others follow the natural sort ordering of their<a name="line.33"></a>
<span class="sourceLineNo">034</span> * elements. Either way, null elements are not supported.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p&gt;Unlike {@link Multisets#unmodifiableSortedMultiset}, which is a &lt;i&gt;view&lt;/i&gt; of a separate<a name="line.36"></a>
<span class="sourceLineNo">037</span> * collection that can still change, an instance of {@code ImmutableSortedMultiset} contains its<a name="line.37"></a>
<span class="sourceLineNo">038</span> * own private data and will &lt;i&gt;never&lt;/i&gt; change. This class is convenient for {@code public static<a name="line.38"></a>
<span class="sourceLineNo">039</span> * final} multisets ("constant multisets") and also lets you easily make a "defensive copy" of a<a name="line.39"></a>
<span class="sourceLineNo">040</span> * set provided to your class by a caller.<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p&gt;The multisets returned by the {@link #headMultiset}, {@link #tailMultiset}, and<a name="line.42"></a>
<span class="sourceLineNo">043</span> * {@link #subMultiset} methods share the same array as the original multiset, preventing that<a name="line.43"></a>
<span class="sourceLineNo">044</span> * array from being garbage collected. If this is a concern, the data may be copied into a<a name="line.44"></a>
<span class="sourceLineNo">045</span> * correctly-sized array by calling {@link #copyOfSorted}.<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p&gt;&lt;b&gt;Note on element equivalence:&lt;/b&gt; The {@link #contains(Object)},<a name="line.47"></a>
<span class="sourceLineNo">048</span> * {@link #containsAll(Collection)}, and {@link #equals(Object)} implementations must check whether<a name="line.48"></a>
<span class="sourceLineNo">049</span> * a provided object is equivalent to an element in the collection. Unlike most collections, an<a name="line.49"></a>
<span class="sourceLineNo">050</span> * {@code ImmutableSortedMultiset} doesn't use {@link Object#equals} to determine if two elements<a name="line.50"></a>
<span class="sourceLineNo">051</span> * are equivalent. Instead, with an explicit comparator, the following relation determines whether<a name="line.51"></a>
<span class="sourceLineNo">052</span> * elements {@code x} and {@code y} are equivalent:<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;pre&gt;   {@code<a name="line.54"></a>
<span class="sourceLineNo">055</span> *<a name="line.55"></a>
<span class="sourceLineNo">056</span> *   {(x, y) | comparator.compare(x, y) == 0}}&lt;/pre&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> *<a name="line.57"></a>
<span class="sourceLineNo">058</span> * With natural ordering of elements, the following relation determines whether two elements are<a name="line.58"></a>
<span class="sourceLineNo">059</span> * equivalent:<a name="line.59"></a>
<span class="sourceLineNo">060</span> *<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;pre&gt;   {@code<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> *   {(x, y) | x.compareTo(y) == 0}}&lt;/pre&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> *<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;b&gt;Warning:&lt;/b&gt; Like most multisets, an {@code ImmutableSortedMultiset} will not function<a name="line.65"></a>
<span class="sourceLineNo">066</span> * correctly if an element is modified after being placed in the multiset. For this reason, and to<a name="line.66"></a>
<span class="sourceLineNo">067</span> * avoid general confusion, it is strongly recommended to place only immutable objects into this<a name="line.67"></a>
<span class="sourceLineNo">068</span> * collection.<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;p&gt;&lt;b&gt;Note:&lt;/b&gt; Although this class is not final, it cannot be subclassed as it has no public or<a name="line.70"></a>
<span class="sourceLineNo">071</span> * protected constructors. Thus, instances of this type are guaranteed to be immutable.<a name="line.71"></a>
<span class="sourceLineNo">072</span> *<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;p&gt;See the Guava User Guide article on &lt;a href=<a name="line.73"></a>
<span class="sourceLineNo">074</span> * "http://code.google.com/p/guava-libraries/wiki/ImmutableCollectionsExplained"&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> * immutable collections&lt;/a&gt;.<a name="line.75"></a>
<span class="sourceLineNo">076</span> *<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @author Louis Wasserman<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @since 12.0<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span>@Beta<a name="line.80"></a>
<span class="sourceLineNo">081</span>@GwtIncompatible("hasn't been tested yet")<a name="line.81"></a>
<span class="sourceLineNo">082</span>public abstract class ImmutableSortedMultiset&lt;E&gt; extends ImmutableSortedMultisetFauxverideShim&lt;E&gt;<a name="line.82"></a>
<span class="sourceLineNo">083</span>    implements SortedMultiset&lt;E&gt; {<a name="line.83"></a>
<span class="sourceLineNo">084</span>  // TODO(user): GWT compatibility<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span>  private static final Comparator&lt;Comparable&gt; NATURAL_ORDER = Ordering.natural();<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>  private static final ImmutableSortedMultiset&lt;Comparable&gt; NATURAL_EMPTY_MULTISET =<a name="line.88"></a>
<span class="sourceLineNo">089</span>      new EmptyImmutableSortedMultiset&lt;Comparable&gt;(NATURAL_ORDER);<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span>  /**<a name="line.91"></a>
<span class="sourceLineNo">092</span>   * Returns the empty immutable sorted multiset.<a name="line.92"></a>
<span class="sourceLineNo">093</span>   */<a name="line.93"></a>
<span class="sourceLineNo">094</span>  @SuppressWarnings("unchecked")<a name="line.94"></a>
<span class="sourceLineNo">095</span>  public static &lt;E&gt; ImmutableSortedMultiset&lt;E&gt; of() {<a name="line.95"></a>
<span class="sourceLineNo">096</span>    return (ImmutableSortedMultiset) NATURAL_EMPTY_MULTISET;<a name="line.96"></a>
<span class="sourceLineNo">097</span>  }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>  /**<a name="line.99"></a>
<span class="sourceLineNo">100</span>   * Returns an immutable sorted multiset containing a single element.<a name="line.100"></a>
<span class="sourceLineNo">101</span>   */<a name="line.101"></a>
<span class="sourceLineNo">102</span>  public static &lt;E extends Comparable&lt;? super E&gt;&gt; ImmutableSortedMultiset&lt;E&gt; of(E element) {<a name="line.102"></a>
<span class="sourceLineNo">103</span>    RegularImmutableSortedSet&lt;E&gt; elementSet =<a name="line.103"></a>
<span class="sourceLineNo">104</span>        (RegularImmutableSortedSet&lt;E&gt;) ImmutableSortedSet.of(element);<a name="line.104"></a>
<span class="sourceLineNo">105</span>    int[] counts = {1};<a name="line.105"></a>
<span class="sourceLineNo">106</span>    long[] cumulativeCounts = {0, 1};<a name="line.106"></a>
<span class="sourceLineNo">107</span>    return new RegularImmutableSortedMultiset&lt;E&gt;(elementSet, counts, cumulativeCounts, 0, 1);<a name="line.107"></a>
<span class="sourceLineNo">108</span>  }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span>  /**<a name="line.110"></a>
<span class="sourceLineNo">111</span>   * Returns an immutable sorted multiset containing the given elements sorted by their natural<a name="line.111"></a>
<span class="sourceLineNo">112</span>   * ordering.<a name="line.112"></a>
<span class="sourceLineNo">113</span>   *<a name="line.113"></a>
<span class="sourceLineNo">114</span>   * @throws NullPointerException if any element is null<a name="line.114"></a>
<span class="sourceLineNo">115</span>   */<a name="line.115"></a>
<span class="sourceLineNo">116</span>  @SuppressWarnings("unchecked")<a name="line.116"></a>
<span class="sourceLineNo">117</span>  public static &lt;E extends Comparable&lt;? super E&gt;&gt; ImmutableSortedMultiset&lt;E&gt; of(E e1, E e2) {<a name="line.117"></a>
<span class="sourceLineNo">118</span>    return copyOf(Ordering.natural(), Arrays.asList(e1, e2));<a name="line.118"></a>
<span class="sourceLineNo">119</span>  }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>  /**<a name="line.121"></a>
<span class="sourceLineNo">122</span>   * Returns an immutable sorted multiset containing the given elements sorted by their natural<a name="line.122"></a>
<span class="sourceLineNo">123</span>   * ordering.<a name="line.123"></a>
<span class="sourceLineNo">124</span>   *<a name="line.124"></a>
<span class="sourceLineNo">125</span>   * @throws NullPointerException if any element is null<a name="line.125"></a>
<span class="sourceLineNo">126</span>   */<a name="line.126"></a>
<span class="sourceLineNo">127</span>  @SuppressWarnings("unchecked")<a name="line.127"></a>
<span class="sourceLineNo">128</span>  public static &lt;E extends Comparable&lt;? super E&gt;&gt; ImmutableSortedMultiset&lt;E&gt; of(E e1, E e2, E e3) {<a name="line.128"></a>
<span class="sourceLineNo">129</span>    return copyOf(Ordering.natural(), Arrays.asList(e1, e2, e3));<a name="line.129"></a>
<span class="sourceLineNo">130</span>  }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span>  /**<a name="line.132"></a>
<span class="sourceLineNo">133</span>   * Returns an immutable sorted multiset containing the given elements sorted by their natural<a name="line.133"></a>
<span class="sourceLineNo">134</span>   * ordering.<a name="line.134"></a>
<span class="sourceLineNo">135</span>   *<a name="line.135"></a>
<span class="sourceLineNo">136</span>   * @throws NullPointerException if any element is null<a name="line.136"></a>
<span class="sourceLineNo">137</span>   */<a name="line.137"></a>
<span class="sourceLineNo">138</span>  @SuppressWarnings("unchecked")<a name="line.138"></a>
<span class="sourceLineNo">139</span>  public static &lt;E extends Comparable&lt;? super E&gt;&gt; ImmutableSortedMultiset&lt;E&gt; of(<a name="line.139"></a>
<span class="sourceLineNo">140</span>      E e1, E e2, E e3, E e4) {<a name="line.140"></a>
<span class="sourceLineNo">141</span>    return copyOf(Ordering.natural(), Arrays.asList(e1, e2, e3, e4));<a name="line.141"></a>
<span class="sourceLineNo">142</span>  }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span>  /**<a name="line.144"></a>
<span class="sourceLineNo">145</span>   * Returns an immutable sorted multiset containing the given elements sorted by their natural<a name="line.145"></a>
<span class="sourceLineNo">146</span>   * ordering.<a name="line.146"></a>
<span class="sourceLineNo">147</span>   *<a name="line.147"></a>
<span class="sourceLineNo">148</span>   * @throws NullPointerException if any element is null<a name="line.148"></a>
<span class="sourceLineNo">149</span>   */<a name="line.149"></a>
<span class="sourceLineNo">150</span>  @SuppressWarnings("unchecked")<a name="line.150"></a>
<span class="sourceLineNo">151</span>  public static &lt;E extends Comparable&lt;? super E&gt;&gt; ImmutableSortedMultiset&lt;E&gt; of(<a name="line.151"></a>
<span class="sourceLineNo">152</span>      E e1, E e2, E e3, E e4, E e5) {<a name="line.152"></a>
<span class="sourceLineNo">153</span>    return copyOf(Ordering.natural(), Arrays.asList(e1, e2, e3, e4, e5));<a name="line.153"></a>
<span class="sourceLineNo">154</span>  }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span>  /**<a name="line.156"></a>
<span class="sourceLineNo">157</span>   * Returns an immutable sorted multiset containing the given elements sorted by their natural<a name="line.157"></a>
<span class="sourceLineNo">158</span>   * ordering.<a name="line.158"></a>
<span class="sourceLineNo">159</span>   *<a name="line.159"></a>
<span class="sourceLineNo">160</span>   * @throws NullPointerException if any element is null<a name="line.160"></a>
<span class="sourceLineNo">161</span>   */<a name="line.161"></a>
<span class="sourceLineNo">162</span>  @SuppressWarnings("unchecked")<a name="line.162"></a>
<span class="sourceLineNo">163</span>  public static &lt;E extends Comparable&lt;? super E&gt;&gt; ImmutableSortedMultiset&lt;E&gt; of(<a name="line.163"></a>
<span class="sourceLineNo">164</span>      E e1, E e2, E e3, E e4, E e5, E e6, E... remaining) {<a name="line.164"></a>
<span class="sourceLineNo">165</span>    int size = remaining.length + 6;<a name="line.165"></a>
<span class="sourceLineNo">166</span>    List&lt;E&gt; all = Lists.newArrayListWithCapacity(size);<a name="line.166"></a>
<span class="sourceLineNo">167</span>    Collections.addAll(all, e1, e2, e3, e4, e5, e6);<a name="line.167"></a>
<span class="sourceLineNo">168</span>    Collections.addAll(all, remaining);<a name="line.168"></a>
<span class="sourceLineNo">169</span>    return copyOf(Ordering.natural(), all);<a name="line.169"></a>
<span class="sourceLineNo">170</span>  }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span>  /**<a name="line.172"></a>
<span class="sourceLineNo">173</span>   * Returns an immutable sorted multiset containing the given elements sorted by their natural<a name="line.173"></a>
<span class="sourceLineNo">174</span>   * ordering.<a name="line.174"></a>
<span class="sourceLineNo">175</span>   *<a name="line.175"></a>
<span class="sourceLineNo">176</span>   * @throws NullPointerException if any of {@code elements} is null<a name="line.176"></a>
<span class="sourceLineNo">177</span>   */<a name="line.177"></a>
<span class="sourceLineNo">178</span>  public static &lt;E extends Comparable&lt;? super E&gt;&gt; ImmutableSortedMultiset&lt;E&gt; copyOf(E[] elements) {<a name="line.178"></a>
<span class="sourceLineNo">179</span>    return copyOf(Ordering.natural(), Arrays.asList(elements));<a name="line.179"></a>
<span class="sourceLineNo">180</span>  }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span>  /**<a name="line.182"></a>
<span class="sourceLineNo">183</span>   * Returns an immutable sorted multiset containing the given elements sorted by their natural<a name="line.183"></a>
<span class="sourceLineNo">184</span>   * ordering. To create a copy of a {@code SortedMultiset} that preserves the<a name="line.184"></a>
<span class="sourceLineNo">185</span>   * comparator, call {@link #copyOfSorted} instead. This method iterates over {@code elements} at<a name="line.185"></a>
<span class="sourceLineNo">186</span>   * most once.<a name="line.186"></a>
<span class="sourceLineNo">187</span>   *<a name="line.187"></a>
<span class="sourceLineNo">188</span>   * &lt;p&gt;Note that if {@code s} is a {@code multiset&lt;String&gt;}, then {@code<a name="line.188"></a>
<span class="sourceLineNo">189</span>   * ImmutableSortedMultiset.copyOf(s)} returns an {@code ImmutableSortedMultiset&lt;String&gt;}<a name="line.189"></a>
<span class="sourceLineNo">190</span>   * containing each of the strings in {@code s}, while {@code ImmutableSortedMultiset.of(s)}<a name="line.190"></a>
<span class="sourceLineNo">191</span>   * returns an {@code ImmutableSortedMultiset&lt;multiset&lt;String&gt;&gt;} containing one element (the given<a name="line.191"></a>
<span class="sourceLineNo">192</span>   * multiset itself).<a name="line.192"></a>
<span class="sourceLineNo">193</span>   *<a name="line.193"></a>
<span class="sourceLineNo">194</span>   * &lt;p&gt;Despite the method name, this method attempts to avoid actually copying the data when it is<a name="line.194"></a>
<span class="sourceLineNo">195</span>   * safe to do so. The exact circumstances under which a copy will or will not be performed are<a name="line.195"></a>
<span class="sourceLineNo">196</span>   * undocumented and subject to change.<a name="line.196"></a>
<span class="sourceLineNo">197</span>   *<a name="line.197"></a>
<span class="sourceLineNo">198</span>   * &lt;p&gt;This method is not type-safe, as it may be called on elements that are not mutually<a name="line.198"></a>
<span class="sourceLineNo">199</span>   * comparable.<a name="line.199"></a>
<span class="sourceLineNo">200</span>   *<a name="line.200"></a>
<span class="sourceLineNo">201</span>   * @throws ClassCastException if the elements are not mutually comparable<a name="line.201"></a>
<span class="sourceLineNo">202</span>   * @throws NullPointerException if any of {@code elements} is null<a name="line.202"></a>
<span class="sourceLineNo">203</span>   */<a name="line.203"></a>
<span class="sourceLineNo">204</span>  public static &lt;E&gt; ImmutableSortedMultiset&lt;E&gt; copyOf(Iterable&lt;? extends E&gt; elements) {<a name="line.204"></a>
<span class="sourceLineNo">205</span>    // Hack around E not being a subtype of Comparable.<a name="line.205"></a>
<span class="sourceLineNo">206</span>    // Unsafe, see ImmutableSortedMultisetFauxverideShim.<a name="line.206"></a>
<span class="sourceLineNo">207</span>    @SuppressWarnings("unchecked")<a name="line.207"></a>
<span class="sourceLineNo">208</span>    Ordering&lt;E&gt; naturalOrder = (Ordering&lt;E&gt;) Ordering.&lt;Comparable&gt;natural();<a name="line.208"></a>
<span class="sourceLineNo">209</span>    return copyOf(naturalOrder, elements);<a name="line.209"></a>
<span class="sourceLineNo">210</span>  }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span>  /**<a name="line.212"></a>
<span class="sourceLineNo">213</span>   * Returns an immutable sorted multiset containing the given elements sorted by their natural<a name="line.213"></a>
<span class="sourceLineNo">214</span>   * ordering.<a name="line.214"></a>
<span class="sourceLineNo">215</span>   *<a name="line.215"></a>
<span class="sourceLineNo">216</span>   * &lt;p&gt;This method is not type-safe, as it may be called on elements that are not mutually<a name="line.216"></a>
<span class="sourceLineNo">217</span>   * comparable.<a name="line.217"></a>
<span class="sourceLineNo">218</span>   *<a name="line.218"></a>
<span class="sourceLineNo">219</span>   * @throws ClassCastException if the elements are not mutually comparable<a name="line.219"></a>
<span class="sourceLineNo">220</span>   * @throws NullPointerException if any of {@code elements} is null<a name="line.220"></a>
<span class="sourceLineNo">221</span>   */<a name="line.221"></a>
<span class="sourceLineNo">222</span>  public static &lt;E&gt; ImmutableSortedMultiset&lt;E&gt; copyOf(Iterator&lt;? extends E&gt; elements) {<a name="line.222"></a>
<span class="sourceLineNo">223</span>    // Hack around E not being a subtype of Comparable.<a name="line.223"></a>
<span class="sourceLineNo">224</span>    // Unsafe, see ImmutableSortedMultisetFauxverideShim.<a name="line.224"></a>
<span class="sourceLineNo">225</span>    @SuppressWarnings("unchecked")<a name="line.225"></a>
<span class="sourceLineNo">226</span>    Ordering&lt;E&gt; naturalOrder = (Ordering&lt;E&gt;) Ordering.&lt;Comparable&gt;natural();<a name="line.226"></a>
<span class="sourceLineNo">227</span>    return copyOf(naturalOrder, elements);<a name="line.227"></a>
<span class="sourceLineNo">228</span>  }<a name="line.228"></a>
<span class="sourceLineNo">229</span><a name="line.229"></a>
<span class="sourceLineNo">230</span>  /**<a name="line.230"></a>
<span class="sourceLineNo">231</span>   * Returns an immutable sorted multiset containing the given elements sorted by the given {@code<a name="line.231"></a>
<span class="sourceLineNo">232</span>   * Comparator}.<a name="line.232"></a>
<span class="sourceLineNo">233</span>   *<a name="line.233"></a>
<span class="sourceLineNo">234</span>   * @throws NullPointerException if {@code comparator} or any of {@code elements} is null<a name="line.234"></a>
<span class="sourceLineNo">235</span>   */<a name="line.235"></a>
<span class="sourceLineNo">236</span>  public static &lt;E&gt; ImmutableSortedMultiset&lt;E&gt; copyOf(<a name="line.236"></a>
<span class="sourceLineNo">237</span>      Comparator&lt;? super E&gt; comparator, Iterator&lt;? extends E&gt; elements) {<a name="line.237"></a>
<span class="sourceLineNo">238</span>    checkNotNull(comparator);<a name="line.238"></a>
<span class="sourceLineNo">239</span>    return new Builder&lt;E&gt;(comparator).addAll(elements).build();<a name="line.239"></a>
<span class="sourceLineNo">240</span>  }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span>  /**<a name="line.242"></a>
<span class="sourceLineNo">243</span>   * Returns an immutable sorted multiset containing the given elements sorted by the given {@code<a name="line.243"></a>
<span class="sourceLineNo">244</span>   * Comparator}. This method iterates over {@code elements} at most once.<a name="line.244"></a>
<span class="sourceLineNo">245</span>   *<a name="line.245"></a>
<span class="sourceLineNo">246</span>   * &lt;p&gt;Despite the method name, this method attempts to avoid actually copying the data when it is<a name="line.246"></a>
<span class="sourceLineNo">247</span>   * safe to do so. The exact circumstances under which a copy will or will not be performed are<a name="line.247"></a>
<span class="sourceLineNo">248</span>   * undocumented and subject to change.<a name="line.248"></a>
<span class="sourceLineNo">249</span>   *<a name="line.249"></a>
<span class="sourceLineNo">250</span>   * @throws NullPointerException if {@code comparator} or any of {@code elements} is null<a name="line.250"></a>
<span class="sourceLineNo">251</span>   */<a name="line.251"></a>
<span class="sourceLineNo">252</span>  public static &lt;E&gt; ImmutableSortedMultiset&lt;E&gt; copyOf(<a name="line.252"></a>
<span class="sourceLineNo">253</span>      Comparator&lt;? super E&gt; comparator, Iterable&lt;? extends E&gt; elements) {<a name="line.253"></a>
<span class="sourceLineNo">254</span>    if (elements instanceof ImmutableSortedMultiset) {<a name="line.254"></a>
<span class="sourceLineNo">255</span>      @SuppressWarnings("unchecked") // immutable collections are always safe for covariant casts<a name="line.255"></a>
<span class="sourceLineNo">256</span>      ImmutableSortedMultiset&lt;E&gt; multiset = (ImmutableSortedMultiset&lt;E&gt;) elements;<a name="line.256"></a>
<span class="sourceLineNo">257</span>      if (comparator.equals(multiset.comparator())) {<a name="line.257"></a>
<span class="sourceLineNo">258</span>        if (multiset.isPartialView()) {<a name="line.258"></a>
<span class="sourceLineNo">259</span>          return copyOfSortedEntries(comparator, multiset.entrySet().asList());<a name="line.259"></a>
<span class="sourceLineNo">260</span>        } else {<a name="line.260"></a>
<span class="sourceLineNo">261</span>          return multiset;<a name="line.261"></a>
<span class="sourceLineNo">262</span>        }<a name="line.262"></a>
<span class="sourceLineNo">263</span>      }<a name="line.263"></a>
<span class="sourceLineNo">264</span>    }<a name="line.264"></a>
<span class="sourceLineNo">265</span>    elements = Lists.newArrayList(elements); // defensive copy<a name="line.265"></a>
<span class="sourceLineNo">266</span>    TreeMultiset&lt;E&gt; sortedCopy = TreeMultiset.create(checkNotNull(comparator));<a name="line.266"></a>
<span class="sourceLineNo">267</span>    Iterables.addAll(sortedCopy, elements);<a name="line.267"></a>
<span class="sourceLineNo">268</span>    return copyOfSortedEntries(comparator, sortedCopy.entrySet());<a name="line.268"></a>
<span class="sourceLineNo">269</span>  }<a name="line.269"></a>
<span class="sourceLineNo">270</span><a name="line.270"></a>
<span class="sourceLineNo">271</span>  /**<a name="line.271"></a>
<span class="sourceLineNo">272</span>   * Returns an immutable sorted multiset containing the elements of a sorted multiset, sorted by<a name="line.272"></a>
<span class="sourceLineNo">273</span>   * the same {@code Comparator}. That behavior differs from {@link #copyOf(Iterable)}, which<a name="line.273"></a>
<span class="sourceLineNo">274</span>   * always uses the natural ordering of the elements.<a name="line.274"></a>
<span class="sourceLineNo">275</span>   *<a name="line.275"></a>
<span class="sourceLineNo">276</span>   * &lt;p&gt;Despite the method name, this method attempts to avoid actually copying the data when it is<a name="line.276"></a>
<span class="sourceLineNo">277</span>   * safe to do so. The exact circumstances under which a copy will or will not be performed are<a name="line.277"></a>
<span class="sourceLineNo">278</span>   * undocumented and subject to change.<a name="line.278"></a>
<span class="sourceLineNo">279</span>   *<a name="line.279"></a>
<span class="sourceLineNo">280</span>   * &lt;p&gt;This method is safe to use even when {@code sortedMultiset} is a synchronized or concurrent<a name="line.280"></a>
<span class="sourceLineNo">281</span>   * collection that is currently being modified by another thread.<a name="line.281"></a>
<span class="sourceLineNo">282</span>   *<a name="line.282"></a>
<span class="sourceLineNo">283</span>   * @throws NullPointerException if {@code sortedMultiset} or any of its elements is null<a name="line.283"></a>
<span class="sourceLineNo">284</span>   */<a name="line.284"></a>
<span class="sourceLineNo">285</span>  public static &lt;E&gt; ImmutableSortedMultiset&lt;E&gt; copyOfSorted(SortedMultiset&lt;E&gt; sortedMultiset) {<a name="line.285"></a>
<span class="sourceLineNo">286</span>    return copyOfSortedEntries(sortedMultiset.comparator(),<a name="line.286"></a>
<span class="sourceLineNo">287</span>        Lists.newArrayList(sortedMultiset.entrySet()));<a name="line.287"></a>
<span class="sourceLineNo">288</span>  }<a name="line.288"></a>
<span class="sourceLineNo">289</span><a name="line.289"></a>
<span class="sourceLineNo">290</span>  private static &lt;E&gt; ImmutableSortedMultiset&lt;E&gt; copyOfSortedEntries(<a name="line.290"></a>
<span class="sourceLineNo">291</span>      Comparator&lt;? super E&gt; comparator, Collection&lt;Entry&lt;E&gt;&gt; entries) {<a name="line.291"></a>
<span class="sourceLineNo">292</span>    if (entries.isEmpty()) {<a name="line.292"></a>
<span class="sourceLineNo">293</span>      return emptyMultiset(comparator);<a name="line.293"></a>
<span class="sourceLineNo">294</span>    }<a name="line.294"></a>
<span class="sourceLineNo">295</span>    ImmutableList.Builder&lt;E&gt; elementsBuilder = new ImmutableList.Builder&lt;E&gt;(entries.size());<a name="line.295"></a>
<span class="sourceLineNo">296</span>    int[] counts = new int[entries.size()];<a name="line.296"></a>
<span class="sourceLineNo">297</span>    long[] cumulativeCounts = new long[entries.size() + 1];<a name="line.297"></a>
<span class="sourceLineNo">298</span>    int i = 0;<a name="line.298"></a>
<span class="sourceLineNo">299</span>    for (Entry&lt;E&gt; entry : entries) {<a name="line.299"></a>
<span class="sourceLineNo">300</span>      elementsBuilder.add(entry.getElement());<a name="line.300"></a>
<span class="sourceLineNo">301</span>      counts[i] = entry.getCount();<a name="line.301"></a>
<span class="sourceLineNo">302</span>      cumulativeCounts[i + 1] = cumulativeCounts[i] + counts[i];<a name="line.302"></a>
<span class="sourceLineNo">303</span>      i++;<a name="line.303"></a>
<span class="sourceLineNo">304</span>    }<a name="line.304"></a>
<span class="sourceLineNo">305</span>    return new RegularImmutableSortedMultiset&lt;E&gt;(<a name="line.305"></a>
<span class="sourceLineNo">306</span>        new RegularImmutableSortedSet&lt;E&gt;(elementsBuilder.build(), comparator),<a name="line.306"></a>
<span class="sourceLineNo">307</span>        counts, cumulativeCounts, 0, entries.size());<a name="line.307"></a>
<span class="sourceLineNo">308</span>  }<a name="line.308"></a>
<span class="sourceLineNo">309</span><a name="line.309"></a>
<span class="sourceLineNo">310</span>  @SuppressWarnings("unchecked")<a name="line.310"></a>
<span class="sourceLineNo">311</span>  static &lt;E&gt; ImmutableSortedMultiset&lt;E&gt; emptyMultiset(Comparator&lt;? super E&gt; comparator) {<a name="line.311"></a>
<span class="sourceLineNo">312</span>    if (NATURAL_ORDER.equals(comparator)) {<a name="line.312"></a>
<span class="sourceLineNo">313</span>      return (ImmutableSortedMultiset) NATURAL_EMPTY_MULTISET;<a name="line.313"></a>
<span class="sourceLineNo">314</span>    }<a name="line.314"></a>
<span class="sourceLineNo">315</span>    return new EmptyImmutableSortedMultiset&lt;E&gt;(comparator);<a name="line.315"></a>
<span class="sourceLineNo">316</span>  }<a name="line.316"></a>
<span class="sourceLineNo">317</span><a name="line.317"></a>
<span class="sourceLineNo">318</span>  ImmutableSortedMultiset() {}<a name="line.318"></a>
<span class="sourceLineNo">319</span><a name="line.319"></a>
<span class="sourceLineNo">320</span>  @Override<a name="line.320"></a>
<span class="sourceLineNo">321</span>  public final Comparator&lt;? super E&gt; comparator() {<a name="line.321"></a>
<span class="sourceLineNo">322</span>    return elementSet().comparator();<a name="line.322"></a>
<span class="sourceLineNo">323</span>  }<a name="line.323"></a>
<span class="sourceLineNo">324</span><a name="line.324"></a>
<span class="sourceLineNo">325</span>  @Override<a name="line.325"></a>
<span class="sourceLineNo">326</span>  public abstract ImmutableSortedSet&lt;E&gt; elementSet();<a name="line.326"></a>
<span class="sourceLineNo">327</span><a name="line.327"></a>
<span class="sourceLineNo">328</span>  transient ImmutableSortedMultiset&lt;E&gt; descendingMultiset;<a name="line.328"></a>
<span class="sourceLineNo">329</span><a name="line.329"></a>
<span class="sourceLineNo">330</span>  @Override<a name="line.330"></a>
<span class="sourceLineNo">331</span>  public ImmutableSortedMultiset&lt;E&gt; descendingMultiset() {<a name="line.331"></a>
<span class="sourceLineNo">332</span>    ImmutableSortedMultiset&lt;E&gt; result = descendingMultiset;<a name="line.332"></a>
<span class="sourceLineNo">333</span>    if (result == null) {<a name="line.333"></a>
<span class="sourceLineNo">334</span>      return descendingMultiset = new DescendingImmutableSortedMultiset&lt;E&gt;(this);<a name="line.334"></a>
<span class="sourceLineNo">335</span>    }<a name="line.335"></a>
<span class="sourceLineNo">336</span>    return result;<a name="line.336"></a>
<span class="sourceLineNo">337</span>  }<a name="line.337"></a>
<span class="sourceLineNo">338</span><a name="line.338"></a>
<span class="sourceLineNo">339</span>  /**<a name="line.339"></a>
<span class="sourceLineNo">340</span>   * {@inheritDoc}<a name="line.340"></a>
<span class="sourceLineNo">341</span>   *<a name="line.341"></a>
<span class="sourceLineNo">342</span>   * &lt;p&gt;This implementation is guaranteed to throw an {@link UnsupportedOperationException}.<a name="line.342"></a>
<span class="sourceLineNo">343</span>   *<a name="line.343"></a>
<span class="sourceLineNo">344</span>   * @throws UnsupportedOperationException always<a name="line.344"></a>
<span class="sourceLineNo">345</span>   * @deprecated Unsupported operation.<a name="line.345"></a>
<span class="sourceLineNo">346</span>   */<a name="line.346"></a>
<span class="sourceLineNo">347</span>  @Deprecated<a name="line.347"></a>
<span class="sourceLineNo">348</span>  @Override<a name="line.348"></a>
<span class="sourceLineNo">349</span>  public final Entry&lt;E&gt; pollFirstEntry() {<a name="line.349"></a>
<span class="sourceLineNo">350</span>    throw new UnsupportedOperationException();<a name="line.350"></a>
<span class="sourceLineNo">351</span>  }<a name="line.351"></a>
<span class="sourceLineNo">352</span><a name="line.352"></a>
<span class="sourceLineNo">353</span>  /**<a name="line.353"></a>
<span class="sourceLineNo">354</span>   * {@inheritDoc}<a name="line.354"></a>
<span class="sourceLineNo">355</span>   *<a name="line.355"></a>
<span class="sourceLineNo">356</span>   * &lt;p&gt;This implementation is guaranteed to throw an {@link UnsupportedOperationException}.<a name="line.356"></a>
<span class="sourceLineNo">357</span>   *<a name="line.357"></a>
<span class="sourceLineNo">358</span>   * @throws UnsupportedOperationException always<a name="line.358"></a>
<span class="sourceLineNo">359</span>   * @deprecated Unsupported operation.<a name="line.359"></a>
<span class="sourceLineNo">360</span>   */<a name="line.360"></a>
<span class="sourceLineNo">361</span>  @Deprecated<a name="line.361"></a>
<span class="sourceLineNo">362</span>  @Override<a name="line.362"></a>
<span class="sourceLineNo">363</span>  public final Entry&lt;E&gt; pollLastEntry() {<a name="line.363"></a>
<span class="sourceLineNo">364</span>    throw new UnsupportedOperationException();<a name="line.364"></a>
<span class="sourceLineNo">365</span>  }<a name="line.365"></a>
<span class="sourceLineNo">366</span><a name="line.366"></a>
<span class="sourceLineNo">367</span>  @Override<a name="line.367"></a>
<span class="sourceLineNo">368</span>  public abstract ImmutableSortedMultiset&lt;E&gt; headMultiset(E upperBound, BoundType boundType);<a name="line.368"></a>
<span class="sourceLineNo">369</span><a name="line.369"></a>
<span class="sourceLineNo">370</span>  @Override<a name="line.370"></a>
<span class="sourceLineNo">371</span>  public ImmutableSortedMultiset&lt;E&gt; subMultiset(<a name="line.371"></a>
<span class="sourceLineNo">372</span>      E lowerBound, BoundType lowerBoundType, E upperBound, BoundType upperBoundType) {<a name="line.372"></a>
<span class="sourceLineNo">373</span>    checkArgument(comparator().compare(lowerBound, upperBound) &lt;= 0,<a name="line.373"></a>
<span class="sourceLineNo">374</span>        "Expected lowerBound &lt;= upperBound but %s &gt; %s", lowerBound, upperBound);<a name="line.374"></a>
<span class="sourceLineNo">375</span>    return tailMultiset(lowerBound, lowerBoundType).headMultiset(upperBound, upperBoundType);<a name="line.375"></a>
<span class="sourceLineNo">376</span>  }<a name="line.376"></a>
<span class="sourceLineNo">377</span><a name="line.377"></a>
<span class="sourceLineNo">378</span>  @Override<a name="line.378"></a>
<span class="sourceLineNo">379</span>  public abstract ImmutableSortedMultiset&lt;E&gt; tailMultiset(E lowerBound, BoundType boundType);<a name="line.379"></a>
<span class="sourceLineNo">380</span><a name="line.380"></a>
<span class="sourceLineNo">381</span>  /**<a name="line.381"></a>
<span class="sourceLineNo">382</span>   * Returns a builder that creates immutable sorted multisets with an explicit comparator. If the<a name="line.382"></a>
<span class="sourceLineNo">383</span>   * comparator has a more general type than the set being generated, such as creating a {@code<a name="line.383"></a>
<span class="sourceLineNo">384</span>   * SortedMultiset&lt;Integer&gt;} with a {@code Comparator&lt;Number&gt;}, use the {@link Builder}<a name="line.384"></a>
<span class="sourceLineNo">385</span>   * constructor instead.<a name="line.385"></a>
<span class="sourceLineNo">386</span>   *<a name="line.386"></a>
<span class="sourceLineNo">387</span>   * @throws NullPointerException if {@code comparator} is null<a name="line.387"></a>
<span class="sourceLineNo">388</span>   */<a name="line.388"></a>
<span class="sourceLineNo">389</span>  public static &lt;E&gt; Builder&lt;E&gt; orderedBy(Comparator&lt;E&gt; comparator) {<a name="line.389"></a>
<span class="sourceLineNo">390</span>    return new Builder&lt;E&gt;(comparator);<a name="line.390"></a>
<span class="sourceLineNo">391</span>  }<a name="line.391"></a>
<span class="sourceLineNo">392</span><a name="line.392"></a>
<span class="sourceLineNo">393</span>  /**<a name="line.393"></a>
<span class="sourceLineNo">394</span>   * Returns a builder that creates immutable sorted multisets whose elements are ordered by the<a name="line.394"></a>
<span class="sourceLineNo">395</span>   * reverse of their natural ordering.<a name="line.395"></a>
<span class="sourceLineNo">396</span>   *<a name="line.396"></a>
<span class="sourceLineNo">397</span>   * &lt;p&gt;Note: the type parameter {@code E} extends {@code Comparable&lt;E&gt;} rather than {@code<a name="line.397"></a>
<span class="sourceLineNo">398</span>   * Comparable&lt;? super E&gt;} as a workaround for javac &lt;a<a name="line.398"></a>
<span class="sourceLineNo">399</span>   * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6468354"&gt;bug 6468354&lt;/a&gt;.<a name="line.399"></a>
<span class="sourceLineNo">400</span>   */<a name="line.400"></a>
<span class="sourceLineNo">401</span>  public static &lt;E extends Comparable&lt;E&gt;&gt; Builder&lt;E&gt; reverseOrder() {<a name="line.401"></a>
<span class="sourceLineNo">402</span>    return new Builder&lt;E&gt;(Ordering.natural().reverse());<a name="line.402"></a>
<span class="sourceLineNo">403</span>  }<a name="line.403"></a>
<span class="sourceLineNo">404</span><a name="line.404"></a>
<span class="sourceLineNo">405</span>  /**<a name="line.405"></a>
<span class="sourceLineNo">406</span>   * Returns a builder that creates immutable sorted multisets whose elements are ordered by their<a name="line.406"></a>
<span class="sourceLineNo">407</span>   * natural ordering. The sorted multisets use {@link Ordering#natural()} as the comparator. This<a name="line.407"></a>
<span class="sourceLineNo">408</span>   * method provides more type-safety than {@link #builder}, as it can be called only for classes<a name="line.408"></a>
<span class="sourceLineNo">409</span>   * that implement {@link Comparable}.<a name="line.409"></a>
<span class="sourceLineNo">410</span>   *<a name="line.410"></a>
<span class="sourceLineNo">411</span>   * &lt;p&gt;Note: the type parameter {@code E} extends {@code Comparable&lt;E&gt;} rather than {@code<a name="line.411"></a>
<span class="sourceLineNo">412</span>   * Comparable&lt;? super E&gt;} as a workaround for javac &lt;a<a name="line.412"></a>
<span class="sourceLineNo">413</span>   * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6468354"&gt;bug 6468354&lt;/a&gt;.<a name="line.413"></a>
<span class="sourceLineNo">414</span>   */<a name="line.414"></a>
<span class="sourceLineNo">415</span>  public static &lt;E extends Comparable&lt;E&gt;&gt; Builder&lt;E&gt; naturalOrder() {<a name="line.415"></a>
<span class="sourceLineNo">416</span>    return new Builder&lt;E&gt;(Ordering.natural());<a name="line.416"></a>
<span class="sourceLineNo">417</span>  }<a name="line.417"></a>
<span class="sourceLineNo">418</span><a name="line.418"></a>
<span class="sourceLineNo">419</span>  /**<a name="line.419"></a>
<span class="sourceLineNo">420</span>   * A builder for creating immutable multiset instances, especially {@code public static final}<a name="line.420"></a>
<span class="sourceLineNo">421</span>   * multisets ("constant multisets"). Example:<a name="line.421"></a>
<span class="sourceLineNo">422</span>   *<a name="line.422"></a>
<span class="sourceLineNo">423</span>   * &lt;pre&gt; {@code<a name="line.423"></a>
<span class="sourceLineNo">424</span>   *<a name="line.424"></a>
<span class="sourceLineNo">425</span>   *   public static final ImmutableSortedMultiset&lt;Bean&gt; BEANS =<a name="line.425"></a>
<span class="sourceLineNo">426</span>   *       new ImmutableSortedMultiset.Builder&lt;Bean&gt;()<a name="line.426"></a>
<span class="sourceLineNo">427</span>   *           .addCopies(Bean.COCOA, 4)<a name="line.427"></a>
<span class="sourceLineNo">428</span>   *           .addCopies(Bean.GARDEN, 6)<a name="line.428"></a>
<span class="sourceLineNo">429</span>   *           .addCopies(Bean.RED, 8)<a name="line.429"></a>
<span class="sourceLineNo">430</span>   *           .addCopies(Bean.BLACK_EYED, 10)<a name="line.430"></a>
<span class="sourceLineNo">431</span>   *           .build();}&lt;/pre&gt;<a name="line.431"></a>
<span class="sourceLineNo">432</span>   *<a name="line.432"></a>
<span class="sourceLineNo">433</span>   * Builder instances can be reused; it is safe to call {@link #build} multiple times to build<a name="line.433"></a>
<span class="sourceLineNo">434</span>   * multiple multisets in series.<a name="line.434"></a>
<span class="sourceLineNo">435</span>   *<a name="line.435"></a>
<span class="sourceLineNo">436</span>   * @since 12.0<a name="line.436"></a>
<span class="sourceLineNo">437</span>   */<a name="line.437"></a>
<span class="sourceLineNo">438</span>  public static class Builder&lt;E&gt; extends ImmutableMultiset.Builder&lt;E&gt; {<a name="line.438"></a>
<span class="sourceLineNo">439</span>    private final Comparator&lt;? super E&gt; comparator;<a name="line.439"></a>
<span class="sourceLineNo">440</span><a name="line.440"></a>
<span class="sourceLineNo">441</span>    /**<a name="line.441"></a>
<span class="sourceLineNo">442</span>     * Creates a new builder. The returned builder is equivalent to the builder generated by<a name="line.442"></a>
<span class="sourceLineNo">443</span>     * {@link ImmutableSortedMultiset#orderedBy(Comparator)}.<a name="line.443"></a>
<span class="sourceLineNo">444</span>     */<a name="line.444"></a>
<span class="sourceLineNo">445</span>    public Builder(Comparator&lt;? super E&gt; comparator) {<a name="line.445"></a>
<span class="sourceLineNo">446</span>      super(TreeMultiset.&lt;E&gt;create(comparator));<a name="line.446"></a>
<span class="sourceLineNo">447</span>      this.comparator = checkNotNull(comparator);<a name="line.447"></a>
<span class="sourceLineNo">448</span>    }<a name="line.448"></a>
<span class="sourceLineNo">449</span><a name="line.449"></a>
<span class="sourceLineNo">450</span>    /**<a name="line.450"></a>
<span class="sourceLineNo">451</span>     * Adds {@code element} to the {@code ImmutableSortedMultiset}.<a name="line.451"></a>
<span class="sourceLineNo">452</span>     *<a name="line.452"></a>
<span class="sourceLineNo">453</span>     * @param element the element to add<a name="line.453"></a>
<span class="sourceLineNo">454</span>     * @return this {@code Builder} object<a name="line.454"></a>
<span class="sourceLineNo">455</span>     * @throws NullPointerException if {@code element} is null<a name="line.455"></a>
<span class="sourceLineNo">456</span>     */<a name="line.456"></a>
<span class="sourceLineNo">457</span>    @Override<a name="line.457"></a>
<span class="sourceLineNo">458</span>    public Builder&lt;E&gt; add(E element) {<a name="line.458"></a>
<span class="sourceLineNo">459</span>      super.add(element);<a name="line.459"></a>
<span class="sourceLineNo">460</span>      return this;<a name="line.460"></a>
<span class="sourceLineNo">461</span>    }<a name="line.461"></a>
<span class="sourceLineNo">462</span><a name="line.462"></a>
<span class="sourceLineNo">463</span>    /**<a name="line.463"></a>
<span class="sourceLineNo">464</span>     * Adds a number of occurrences of an element to this {@code ImmutableSortedMultiset}.<a name="line.464"></a>
<span class="sourceLineNo">465</span>     *<a name="line.465"></a>
<span class="sourceLineNo">466</span>     * @param element the element to add<a name="line.466"></a>
<span class="sourceLineNo">467</span>     * @param occurrences the number of occurrences of the element to add. May be zero, in which<a name="line.467"></a>
<span class="sourceLineNo">468</span>     *        case no change will be made.<a name="line.468"></a>
<span class="sourceLineNo">469</span>     * @return this {@code Builder} object<a name="line.469"></a>
<span class="sourceLineNo">470</span>     * @throws NullPointerException if {@code element} is null<a name="line.470"></a>
<span class="sourceLineNo">471</span>     * @throws IllegalArgumentException if {@code occurrences} is negative, or if this operation<a name="line.471"></a>
<span class="sourceLineNo">472</span>     *         would result in more than {@link Integer#MAX_VALUE} occurrences of the element<a name="line.472"></a>
<span class="sourceLineNo">473</span>     */<a name="line.473"></a>
<span class="sourceLineNo">474</span>    @Override<a name="line.474"></a>
<span class="sourceLineNo">475</span>    public Builder&lt;E&gt; addCopies(E element, int occurrences) {<a name="line.475"></a>
<span class="sourceLineNo">476</span>      super.addCopies(element, occurrences);<a name="line.476"></a>
<span class="sourceLineNo">477</span>      return this;<a name="line.477"></a>
<span class="sourceLineNo">478</span>    }<a name="line.478"></a>
<span class="sourceLineNo">479</span><a name="line.479"></a>
<span class="sourceLineNo">480</span>    /**<a name="line.480"></a>
<span class="sourceLineNo">481</span>     * Adds or removes the necessary occurrences of an element such that the element attains the<a name="line.481"></a>
<span class="sourceLineNo">482</span>     * desired count.<a name="line.482"></a>
<span class="sourceLineNo">483</span>     *<a name="line.483"></a>
<span class="sourceLineNo">484</span>     * @param element the element to add or remove occurrences of<a name="line.484"></a>
<span class="sourceLineNo">485</span>     * @param count the desired count of the element in this multiset<a name="line.485"></a>
<span class="sourceLineNo">486</span>     * @return this {@code Builder} object<a name="line.486"></a>
<span class="sourceLineNo">487</span>     * @throws NullPointerException if {@code element} is null<a name="line.487"></a>
<span class="sourceLineNo">488</span>     * @throws IllegalArgumentException if {@code count} is negative<a name="line.488"></a>
<span class="sourceLineNo">489</span>     */<a name="line.489"></a>
<span class="sourceLineNo">490</span>    @Override<a name="line.490"></a>
<span class="sourceLineNo">491</span>    public Builder&lt;E&gt; setCount(E element, int count) {<a name="line.491"></a>
<span class="sourceLineNo">492</span>      super.setCount(element, count);<a name="line.492"></a>
<span class="sourceLineNo">493</span>      return this;<a name="line.493"></a>
<span class="sourceLineNo">494</span>    }<a name="line.494"></a>
<span class="sourceLineNo">495</span><a name="line.495"></a>
<span class="sourceLineNo">496</span>    /**<a name="line.496"></a>
<span class="sourceLineNo">497</span>     * Adds each element of {@code elements} to the {@code ImmutableSortedMultiset}.<a name="line.497"></a>
<span class="sourceLineNo">498</span>     *<a name="line.498"></a>
<span class="sourceLineNo">499</span>     * @param elements the elements to add<a name="line.499"></a>
<span class="sourceLineNo">500</span>     * @return this {@code Builder} object<a name="line.500"></a>
<span class="sourceLineNo">501</span>     * @throws NullPointerException if {@code elements} is null or contains a null element<a name="line.501"></a>
<span class="sourceLineNo">502</span>     */<a name="line.502"></a>
<span class="sourceLineNo">503</span>    @Override<a name="line.503"></a>
<span class="sourceLineNo">504</span>    public Builder&lt;E&gt; add(E... elements) {<a name="line.504"></a>
<span class="sourceLineNo">505</span>      super.add(elements);<a name="line.505"></a>
<span class="sourceLineNo">506</span>      return this;<a name="line.506"></a>
<span class="sourceLineNo">507</span>    }<a name="line.507"></a>
<span class="sourceLineNo">508</span><a name="line.508"></a>
<span class="sourceLineNo">509</span>    /**<a name="line.509"></a>
<span class="sourceLineNo">510</span>     * Adds each element of {@code elements} to the {@code ImmutableSortedMultiset}.<a name="line.510"></a>
<span class="sourceLineNo">511</span>     *<a name="line.511"></a>
<span class="sourceLineNo">512</span>     * @param elements the {@code Iterable} to add to the {@code ImmutableSortedMultiset}<a name="line.512"></a>
<span class="sourceLineNo">513</span>     * @return this {@code Builder} object<a name="line.513"></a>
<span class="sourceLineNo">514</span>     * @throws NullPointerException if {@code elements} is null or contains a null element<a name="line.514"></a>
<span class="sourceLineNo">515</span>     */<a name="line.515"></a>
<span class="sourceLineNo">516</span>    @Override<a name="line.516"></a>
<span class="sourceLineNo">517</span>    public Builder&lt;E&gt; addAll(Iterable&lt;? extends E&gt; elements) {<a name="line.517"></a>
<span class="sourceLineNo">518</span>      super.addAll(elements);<a name="line.518"></a>
<span class="sourceLineNo">519</span>      return this;<a name="line.519"></a>
<span class="sourceLineNo">520</span>    }<a name="line.520"></a>
<span class="sourceLineNo">521</span><a name="line.521"></a>
<span class="sourceLineNo">522</span>    /**<a name="line.522"></a>
<span class="sourceLineNo">523</span>     * Adds each element of {@code elements} to the {@code ImmutableSortedMultiset}.<a name="line.523"></a>
<span class="sourceLineNo">524</span>     *<a name="line.524"></a>
<span class="sourceLineNo">525</span>     * @param elements the elements to add to the {@code ImmutableSortedMultiset}<a name="line.525"></a>
<span class="sourceLineNo">526</span>     * @return this {@code Builder} object<a name="line.526"></a>
<span class="sourceLineNo">527</span>     * @throws NullPointerException if {@code elements} is null or contains a null element<a name="line.527"></a>
<span class="sourceLineNo">528</span>     */<a name="line.528"></a>
<span class="sourceLineNo">529</span>    @Override<a name="line.529"></a>
<span class="sourceLineNo">530</span>    public Builder&lt;E&gt; addAll(Iterator&lt;? extends E&gt; elements) {<a name="line.530"></a>
<span class="sourceLineNo">531</span>      super.addAll(elements);<a name="line.531"></a>
<span class="sourceLineNo">532</span>      return this;<a name="line.532"></a>
<span class="sourceLineNo">533</span>    }<a name="line.533"></a>
<span class="sourceLineNo">534</span><a name="line.534"></a>
<span class="sourceLineNo">535</span>    /**<a name="line.535"></a>
<span class="sourceLineNo">536</span>     * Returns a newly-created {@code ImmutableSortedMultiset} based on the contents of the {@code<a name="line.536"></a>
<span class="sourceLineNo">537</span>     * Builder}.<a name="line.537"></a>
<span class="sourceLineNo">538</span>     */<a name="line.538"></a>
<span class="sourceLineNo">539</span>    @Override<a name="line.539"></a>
<span class="sourceLineNo">540</span>    public ImmutableSortedMultiset&lt;E&gt; build() {<a name="line.540"></a>
<span class="sourceLineNo">541</span>      return copyOfSorted((SortedMultiset&lt;E&gt;) contents);<a name="line.541"></a>
<span class="sourceLineNo">542</span>    }<a name="line.542"></a>
<span class="sourceLineNo">543</span>  }<a name="line.543"></a>
<span class="sourceLineNo">544</span><a name="line.544"></a>
<span class="sourceLineNo">545</span>  private static final class SerializedForm implements Serializable {<a name="line.545"></a>
<span class="sourceLineNo">546</span>    Comparator comparator;<a name="line.546"></a>
<span class="sourceLineNo">547</span>    Object[] elements;<a name="line.547"></a>
<span class="sourceLineNo">548</span>    int[] counts;<a name="line.548"></a>
<span class="sourceLineNo">549</span><a name="line.549"></a>
<span class="sourceLineNo">550</span>    SerializedForm(SortedMultiset&lt;?&gt; multiset) {<a name="line.550"></a>
<span class="sourceLineNo">551</span>      this.comparator = multiset.comparator();<a name="line.551"></a>
<span class="sourceLineNo">552</span>      int n = multiset.entrySet().size();<a name="line.552"></a>
<span class="sourceLineNo">553</span>      elements = new Object[n];<a name="line.553"></a>
<span class="sourceLineNo">554</span>      counts = new int[n];<a name="line.554"></a>
<span class="sourceLineNo">555</span>      int i = 0;<a name="line.555"></a>
<span class="sourceLineNo">556</span>      for (Entry&lt;?&gt; entry : multiset.entrySet()) {<a name="line.556"></a>
<span class="sourceLineNo">557</span>        elements[i] = entry.getElement();<a name="line.557"></a>
<span class="sourceLineNo">558</span>        counts[i] = entry.getCount();<a name="line.558"></a>
<span class="sourceLineNo">559</span>        i++;<a name="line.559"></a>
<span class="sourceLineNo">560</span>      }<a name="line.560"></a>
<span class="sourceLineNo">561</span>    }<a name="line.561"></a>
<span class="sourceLineNo">562</span><a name="line.562"></a>
<span class="sourceLineNo">563</span>    @SuppressWarnings("unchecked")<a name="line.563"></a>
<span class="sourceLineNo">564</span>    Object readResolve() {<a name="line.564"></a>
<span class="sourceLineNo">565</span>      int n = elements.length;<a name="line.565"></a>
<span class="sourceLineNo">566</span>      Builder&lt;Object&gt; builder = orderedBy(comparator);<a name="line.566"></a>
<span class="sourceLineNo">567</span>      for (int i = 0; i &lt; n; i++) {<a name="line.567"></a>
<span class="sourceLineNo">568</span>        builder.addCopies(elements[i], counts[i]);<a name="line.568"></a>
<span class="sourceLineNo">569</span>      }<a name="line.569"></a>
<span class="sourceLineNo">570</span>      return builder.build();<a name="line.570"></a>
<span class="sourceLineNo">571</span>    }<a name="line.571"></a>
<span class="sourceLineNo">572</span>  }<a name="line.572"></a>
<span class="sourceLineNo">573</span><a name="line.573"></a>
<span class="sourceLineNo">574</span>  @Override<a name="line.574"></a>
<span class="sourceLineNo">575</span>  Object writeReplace() {<a name="line.575"></a>
<span class="sourceLineNo">576</span>    return new SerializedForm(this);<a name="line.576"></a>
<span class="sourceLineNo">577</span>  }<a name="line.577"></a>
<span class="sourceLineNo">578</span>}<a name="line.578"></a>




























































</pre>
</div>
</body>
</html>
